<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../../print.css" type="text/css" media="print">
<meta content="EzLogTargetData,org.flashalchemy.ezlib.ezlog.data.EzLogTargetData,consoleAlpha,consoleThemeId,consoleTitle,formatting,targetType" name="keywords">
<title>org.flashalchemy.ezlib.ezlog.data.EzLogTargetData</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'EzLogTargetData - EzLog_version_1_0_0';
				var baseRef = '../../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">EzLog_version_1_0_0 version 1.0.0</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../all-classes.html')" href="../../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../../index-list.html')" href="../../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../../index.html?org/flashalchemy/ezlib/ezlog/data/EzLogTargetData.html&amp;org/flashalchemy/ezlib/ezlog/data/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;EzLogTargetData</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class EzLogTargetData"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.flashalchemy.ezlib.ezlog.data</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class EzLogTargetData</td>
</tr>
</table>
<p></p>
     <b>Description:</b> The <code>EzLogTargetData</code> class is an object used to store a EzLogTargetData and EzLogFilterData per instance.</br>
     <b>Usage:</b><p/>
     <pre>
          var logTargetPayload:EzLogTargetData = new EzLogTargetData(xml.logTargets.logTarget[i].consoleTitle.toString(),
                         logTargetList.attribute('type')[i].toString(),
                         logTargetList.attribute('formatting')[i].toString(),
                         alpha,
                                                                         themeId);
     </pre>
     <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#consoleAlpha">consoleAlpha</a> : Number<div class="summaryTableDescription">[read-only]
         The alpha value of a log target that constains a custom console
         </div>
</td><td class="summaryTableOwnerCol">EzLogTargetData</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#consoleThemeId">consoleThemeId</a> : String<div class="summaryTableDescription">[read-only]
         The style of the log target that contains a custom console.</div>
</td><td class="summaryTableOwnerCol">EzLogTargetData</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#consoleTitle">consoleTitle</a> : String<div class="summaryTableDescription">[read-only]
         Optional title for log targets that provide a custom console rather than the default Flex IDE console.</br>
         If a console title is set in the xml file for a log target that does not provide a custom console then the title will be ignored.</div>
</td><td class="summaryTableOwnerCol">EzLogTargetData</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#formatting">formatting</a> : String<div class="summaryTableDescription">[read-only]
         The type of formatting to use for the log target.</div>
</td><td class="summaryTableOwnerCol">EzLogTargetData</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#targetType">targetType</a> : String<div class="summaryTableDescription">[read-only]
         The type of log target to use, currently the following classes are supported, use the classname from the appropriate string below:<br>
         <ul><li><code>org.flashalchemy.ezlib.logging.targets.EzTraceTarget</code></li>
         <li><code>org.flashalchemy.ezlib.logging.targets.EzProgramConsoleTarget</code></li></ul>
         </div>
</td><td class="summaryTableOwnerCol">EzLogTargetData</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#EzLogTargetData()">EzLogTargetData</a>(consoleTitle:String, targetType:String, formatting:String, consoleAlpha:Number = 1.0, consoleThemeId:String = null)</div>
<div class="summaryTableDescription">
         Constructor: all values in this data object are read-only and are set via the constructor
         </div>
</td><td class="summaryTableOwnerCol">EzLogTargetData</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="consoleAlpha"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">consoleAlpha</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>consoleAlpha:Number</code>&nbsp;&nbsp;[read-only]<p>
         The alpha value of a log target that constains a custom console
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get consoleAlpha():Number</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">org.flashalchemy.ezlib.logging.targets.EzProgramConsoleTarget</div>
</div>
<a name="consoleThemeId"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">consoleThemeId</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>consoleThemeId:String</code>&nbsp;&nbsp;[read-only]<p>
         The style of the log target that contains a custom console. Currently the following values are supported:</br><ul>
         <li>'default' : The default style for a custom console, a white/grey styled console with black text on a white background</li>
         <li>'monochromatic' : A 'DOS-stlye' monochrome console using color-coded log messages per log level. Displayed on a black background with colored text and green highlights.</li>
         </ul>
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get consoleThemeId():String</code>
<br>
</div>
<a name="consoleTitle"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">consoleTitle</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>consoleTitle:String</code>&nbsp;&nbsp;[read-only]<p>
         Optional title for log targets that provide a custom console rather than the default Flex IDE console.</br>
         If a console title is set in the xml file for a log target that does not provide a custom console then the title will be ignored.
         If a console title is not set in the xml for a log target that has a console than the default window title is used
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get consoleTitle():String</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">org.flashalchemy.ezlib.logging.console.EzConsoleTarget.DEFAULT_WINDOW_TITLE</div>
</div>
<a name="formatting"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">formatting</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>formatting:String</code>&nbsp;&nbsp;[read-only]<p>
         The type of formatting to use for the log target. Currently the valid values are:</br>
         <ul><li>'default' : Standard <code>EzTraceTarget</code> formatting</li>
         <li>'verbose' : Standard <code>EzTraceTarget</code> formatting plus package path and full time information</li>
         <li> 'minimal' : Standard <code>EzTraceTarget</code> formatting with the following changes: Uses truncated Log Levels. Omits timestamp</li>
         <li> 'blank' : All formatting is removed, just the log message appears</li></li>
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get formatting():String</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">org.flashalchemy.ezlib.logging.data.EzLogDataValidator<br>org.flashalchemy.ezlib.logging.targets.EzTraceTarget</div>
</div>
<a name="targetType"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">targetType</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>targetType:String</code>&nbsp;&nbsp;[read-only]<p>
         The type of log target to use, currently the following classes are supported, use the classname from the appropriate string below:<br>
         <ul><li><code>org.flashalchemy.ezlib.logging.targets.EzTraceTarget</code></li>
         <li><code>org.flashalchemy.ezlib.logging.targets.EzProgramConsoleTarget</code></li></ul>
         </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get targetType():String</code>
<br>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">org.flashalchemy.ezlib.logging.data.EzLogDataValidator</div>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="EzLogTargetData()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">EzLogTargetData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function EzLogTargetData(consoleTitle:String, targetType:String, formatting:String, consoleAlpha:Number = 1.0, consoleThemeId:String = null)</code><p>
         Constructor: all values in this data object are read-only and are set via the constructor
         </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">consoleTitle</span>:String</code> &mdash; The type of log target, see the <code>targetType</code> variable description for more information.
         </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">targetType</span>:String</code> &mdash; The type of formatting to use with the log target, see the <code>targetType</code> variable description for more information.
         </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">formatting</span>:String</code> &mdash; Optional value: The alpha value to use for the console if the log target used contains a custom console. See the <code>consoleAlpha</code> variable description for more information.
         </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">consoleAlpha</span>:Number</code> (default = <code>1.0</code>)<code></code> &mdash; Optional value: The style to use for the console if the log target used contains a custom console.
         see the <code>consoleThemeId</code> variable description for more information.
         </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">consoleThemeId</span>:String</code> (default = <code>null</code>)<code></code></td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
